/*
 * Copyright 2008 Nordic Consulting & Development Company
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package pl.ncdc.web.login.client.service;

import com.google.gwt.user.client.rpc.RemoteService;

/**
 * User authentication service.
 * <p>
 * Created on Apr 17, 2008
 *
 * @author hshsce
 * @version $Id: AuthenticationService.java 14 2008-04-17 10:52:44Z hshsce $
 * @see javax.servlet.http.HttpSession
 */
public interface AuthenticationService extends RemoteService {

	/**
	 * Authenticates user identified by the <code>uid</code> and <code>password</code>.
	 * Implementation will use {@link javax.servlet.http.HttpSession} mechanism
	 * for keeping the authenticated session.
	 *
	 * @param uid the user id.
	 * @param password the password.
	 * @param rememberMe flag indicating if user credentials should be stored in cookie.
	 *
	 * @return authentication result.
	 */
	AuthenticationResult login(String uid, String password, boolean rememberMe);

	/**
	 * Deauthenticates the HTTP session.  
	 */
	void logout();

}
